
Solartron Orbit Linux Library
-----------------------------

This is a library for communicating with an Orbit Network. USBIM, RS232 
and ETHIM controllers are supported. Please ensure that you have the correct 
release for your linux architecture (for example, a 64bit release will not work 
on a 32bit linux installation).

To install run the supplied install script, execute:

sudo ./install.sh

The install script will copy the included files to locations under the
/usr subdirectory tree and set their permissions.

It will optionally also install a udev rules file and script to unload the
built in kernal USB to Serial driver for FTDI chips. This is necessary so that
the library can use the FTDI direct driver, enabling Orbit read modes such
as dynamic and automatic USBIM detection.

Prerequisits:

Install the packages of any dependancies using the package management system of 
your Linux distribution, if the libraries are not already installed on your
system.

For example on Ubuntu:
sudo apt-get install libxml2 libqt5widgets5 libqt5xml5

Qt libraries are only required for the GUI applications.

Included Files:

install.sh
	Script to install the Orbit Linux Library.

doc/Orbit_Linux_Library_Manual.docx
	Installed Location: /usr/doc/OrbitLibrary

	Description
	Linux library manual

lib/libOrbitLibrary.so 
	Installed Location: /usr/lib
	Header Files: /usr/src
	
	Description:
	The shared object file for communicating with an Orbit Network.
	Your application will link with this. Header files are installed
	in /usr/src/orbitlinuxlibrary

bin/OrbitRead
	Installed Location: /usr/bin

	Description:
	A console application to read Orbit Networks and WHT channels.

bin/OrbitReadburst
	Installed Location: /usr/bin

	Description:
	A console application to Readburst Orbit Networks.

bin/OrbitReadDynamic
	Installed Location: /usr/bin

	Description:
	A console application to perform Dynamic collections.

bin/OrbitRegistration
	Installed Location: /usr/bin

	Description:
	An application to read and write a configuration file containing the
	configuration of RS232IM and ETHIM controllers.

bin/OrbitLinuxLibraryTest
src/OrbitLinuxLibraryTest
	Installed Location: /usr/bin
	Source Location: /usr/src

	Description:
	A Qt appliction to demonstrate the use of the library.

languages/ErrLang_en.dat
languages/Lang_en.dat
	Installed Location: /usr/share/orbitlinuxlibrary/languages

	Description:
	Error code to natural language dictionary files.

udev/51-Solartron.rules
udev/unbindftdi.sh
	Installed Locations:
	/etc/udev/rules.d/51-Solartron.rules
	/usr/bin/unbindftdi.sh

	A udev rules file for FTDI controllers. This sets the group
	and permissions to allow access to the device by unprivileged
	users. The script will unload the built in FTDI kernel module
	driver allowing the library to use the FTDI direct library.


CHANGELOG
---------

V 1.0	28/05/2020	Initial Release


